Skip to content

Conversation

@agjohnson
Copy link
Collaborator

@agjohnson agjohnson commented Aug 12, 2021

The toctree wrapper can exist outside a section on html4 output. This
resolves some of the issues in #1201, namely a bug introduced with docutils 0.17 support.

This adds the missing margin back in:
image

It also protects against the edge case where toctree can be outside a section completely.

Edit: Nevermind, this does not fix the underlying bug completely, I'm noticing other spacing bugs

Edit edit: I think this does now fix #1201

Fixes #1201

@agjohnson agjohnson added the Bug A bug label Aug 12, 2021
@agjohnson agjohnson added this to the 1.0 milestone Aug 12, 2021
@agjohnson agjohnson requested a review from a team August 12, 2021 21:17
Copy link
Member

@Blendify Blendify left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now this solution works, in the future we may want to remove the ul styles out of the section headings, I don't believe sphinx itself does this so there is a possibility that some styling might fail.

@agjohnson
Copy link
Collaborator Author

I switched the approach in dde72c3, this seems to affect both html4 and html5 output positively. I don't get the bug in sphinx{18,41}-html{4,5} now.

@agjohnson
Copy link
Collaborator Author

I tested quickly with docutils 0.16 and 0.17 and both seemed fine.

The toctree wrapper can exist outside a section on html4 output. This
resolve #1201, a bug introduced with docutils 0.17 support.
HTML5 still had the same issue with spacing.
@agjohnson agjohnson force-pushed the agj/more-fix-docutils-17 branch from dde72c3 to 0850ef1 Compare August 17, 2021 00:35
@agjohnson agjohnson merged commit a5761ae into master Aug 17, 2021
@agjohnson agjohnson deleted the agj/more-fix-docutils-17 branch August 17, 2021 01:18
@rentainhe rentainhe mentioned this pull request Mar 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug A bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Spacing bugs with docutils 0.17 and toctree

3 participants